home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 May: Tool Chest / Developer CD Series May 1996 (Tool Chest) (Apple Computer) (1996).iso / Sample Code / Snippets / Files / Keith's CatSearch / Read Me < prev   
Encoding:
Text File  |  1995-02-15  |  4.8 KB  |  130 lines  |  [TEXT/KAHL]
  1. In article <jhiggins-101293131825@144.212.1.91>, jhiggins@mathworks.com (John
  2. M. Higgins) wrote:
  3. > 
  4. > Is there any way to convince PBCatSearch to start its search in a
  5. > subdirectory?  The parameter block that this function requires has a
  6. > CatPosition record which is set to 0 to start searching at the root level. 
  7. > Inside Mac doesn’t give any clue as to what this value means.  Directory
  8. > IDs do not seem to work.  Perhaps the search does not descend through the
  9. > file hierarchy in an orderly fashion, or perhaps not.  Anyone know?
  10. >
  11.  
  12. OK. I finally decided to show the world that Taligent programmers indeed do
  13. know how to program, and I wrote something to address this need.
  14.  
  15. PBCatSearch doesn’t have any way to allow the programmer to specify a folder
  16. hierarchy to search within. It will let you specify a specific folder to look
  17. in, but not the sub-folders within that folder. The reason for this is that
  18. PBCatSearch searches the catalog file linearly, the format of which bears no
  19. resemblance to the folder hierarchy.
  20.  
  21. I’ve always felt that there are two approaches to coming up with a PBCatSearch
  22. that does what people are asking for:
  23.  
  24. 1) Search the entire hard disk for files with the characteristics you are
  25. interested in. For each file found, walk up the directory chain to see if the
  26. file is within the folder you’re interested in. To speed things up, cache the
  27. results of the chain walking so that you don’t have to perform them again if
  28. you find multiple files in the same sub-folder.
  29.  
  30. 2) Pre-flight the search by walking the directory structure you’re interested
  31. in. During the walk, record the dirID of each directory you find. Then do the
  32. full disk search. For each file you find, compare its dirID with the list you
  33. made.
  34.  
  35. I implemented both this weekend to see how well they worked. I first tried #1,
  36. thinking that, with appropriate caching, it would be faster. Not getting the
  37. performance I wanted, I then tried #2. This one turned out to be slightly
  38. faster for the test case I was using, and the code was much smaller. Here are
  39. some comparisons:
  40.  
  41. Look for all MPW tools...
  42. o ... on my 400 Meg internal drive: 7 seconds
  43. o ... within my MPW folder, using approach #1: 12 seconds
  44. o ... within my MPW folder, using approach #2: 10 seconds
  45.  
  46. The interface to this routine is:
  47.  
  48. OSErr PBCatSearchIn(CSParamBlockRec*, long dirID);
  49.  
  50. By the way, I also took this opportunity to write something I’d always wanted
  51. to do: a high-level interface to PBCatSearch. This CatSearch routine uses a
  52. varargs interface, and works surprisingly well! For instance, to find my MPW
  53. Shell file, I say:
  54.  
  55.         err = CatSearch(&numberFound,
  56.                         csVRefNum, (short) -2,
  57.                         csMatchPtr, &MPWSpec, (long) 1,
  58.                         csFullName, "\pMPW Shell",
  59.                         csFInfoFDType, 'APPL',    // or else it will find my alias!
  60.                         csEndList);
  61.  
  62. (I apologize to everyone for hard-coding my vRefNum in the call!)
  63.  
  64. This says: search for “MPW Shell”, which is an application on the specified
  65. volume. Find the first instance of it, and return the FSSpec in MPWSpec.
  66.  
  67. Now let’s say that you wanted to find all MPW tools on your volume. This could
  68. be done as follows:
  69.  
  70.         err = CatSearch(&numberFound,
  71.                         csVRefNum, (short) -2,
  72.                         csMatchPtr, pMatchBuffer, (long) kMaxMatches,
  73.                         csFInfoFDType, 'MPST',
  74.                         csFInfoFDCreator, 'MPS ',
  75.                         csEndList);
  76.         while ((err == noErr) || (err == eofErr))
  77.         {
  78.             for (loopy = 0; loopy < numberFound; ++loopy)
  79.             {
  80.                 ...process files....
  81.             }
  82.     
  83.             if (err == noErr)
  84.                 err = CatSearch(&numberFound, csContinue);
  85.             else
  86.                 break;
  87.         }
  88.  
  89. Note the use of the “csContinue” feature. CatSearch remembers the last set of
  90. values passed to it and will reuse them if you want. Even so, I’ve found the
  91. loop structure used here a little awkward, so I also implemented a
  92. “csInitOnly” option. This option will let you specify the search options, but
  93. not actually perform the search. You can then write a loop like the
  94. following:
  95.  
  96.         err = CatSearch(&numberFound,
  97.                         csVRefNum, (short) -2,
  98.                         csMatchPtr, pMatchBuffer, (long) kMaxMatches,
  99.                         csFInfoFDType, 'MPST',
  100.                         csFInfoFDCreator, 'MPS ',
  101.                         csInitOnly,    // <<<<<<<<------ this was added
  102.                         csEndList);
  103.     
  104.         while (err == noErr)
  105.         {
  106.             err = CatSearch(&numberFound, csContinue);
  107.             if ((err == noErr) || (err == eofErr))
  108.             {
  109.                 for (loopy = 0; loopy < numberFound; ++loopy)
  110.                 {
  111.                 ...process files....
  112.                 }
  113.             }
  114.         }
  115.  
  116. CatSearch also supports PBCatSearchIn, so you can specify a sub-directory
  117. search thusly:
  118.  
  119.         err = CatSearch(&numberFound,
  120.                         csVRefNum, MPWSpec.vRefNum,
  121.                         csMatchPtr, pMatchBuffer, (long) kMaxMatches,
  122.                         csFInfoFDType, 'MPST',
  123.                         csFInfoFDCreator, 'MPS ',
  124.                         csSearchInDirectory, MPWSpec.parID,    // <<<<<<<<------ this was added
  125.                         csInitOnly,
  126.                         csEndList);
  127.  
  128. --------------------------------------------------------------------------
  129. Keith Rollin      ---      Phantom Programmer      ---      Taligent, Inc.
  130.